附录：JSDoc Block Tags

常用

@author
识别项目的作者
@async
表示一个函数是异步的
@default (同义词: @defaultvalue)
记录默认值
@description (同义词: @desc)
文字描述
@example
提供如何使用该项目的示例
@function (同义词: @func, @method)
描述一个函数或方法
@param (同义词: @arg, @argument)
记录函数的参数
@property (同义词: @prop)
记录对象的属性
@static
记录静态成员
@throws (同义词: @exception)
描述可能抛出的错误
@todo
记录要完成的任务

其他

@abstract (同义词: @virtual)
该成员必须由继承者实现（或覆盖）
@access
指定此成员的访问级别（私有、包私有、公共或受保护）
@augments (同义词: @extends)
指示符号继承并添加到父符号
@callback
标明回调函数
@class (同义词: @constructor)
此函数应使用“new”关键字调用
@classdesc
用下面的文字来描述整个class
@constant (同义词: @const)
将对象记录为常量
@constructs
这个函数成员将是前一个class的构造函数
@copyright
记录一些版权信息
@deprecated
记录这不再是首选方式
@enum
记录相关属性的集合
@event
记录一个事件
@exports
标识由JavaScript模块导出的成员
@external (同义词: @host)
标识外部类、命名空间或模块
@file (同义词: @fileoverview, @overview)
描述一个文件
@fires (同义词: @emits)
描述此方法可能触发的事件
@generator
表明该函数是一个生成器函数
@global
记录一个全局对象
@mixin
记录一个 mixin 对象
@module
记录一个 JavaScript module
@name
记录对象的名称
@requires
当前文件引用了一个 JavaScript module.
@returns (同义词: @return)
记录函数的返回值
@readonly
只读
@see
指明一些其他的参考文档
@since
这个功能是什么时候添加的？
@type
记录对象的类型
@version
记录项目的版本号

文档